<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
<html>
<head>
<title>vendor/hikidoc/TextFormattingRules</title>
</head>
<body>
<h1>Paragraphs</h1>
<p>Consecutive lines are concatenated into a single paragraph.</p>
<p>Blank lines (ones with only a carriage return or with only spaces and tabs) mark the end of a paragraph.</p>
<ul>
<li>Example statement</li>
</ul>
<pre>For example,
if I write like this, these lines
will be formatted as one paragraph.</pre>
<ul>
<li>Example output</li>
</ul>
<p>For example,
if I write like this, these lines
will be formatted as one paragraph.</p>
<h1>Links</h1>
<h2>WikiNames (not yet supported)</h2>
<p>WikiNames are comprised of two or more words put together; each word begins with an uppercase letter, and is followed by at least one lowercase letter or number.</p>
<p>Words in which this condition is met become a WikiName, and a link is automatically attached.</p>
<ul>
<li>Example statement</li>
</ul>
<pre>WikiName     - WikiName
HogeRule1    - WikiName
NOTWIKINAME  - All of the letters are uppercase, so this is not a WikiName
WikiNAME     - All of the letters in NAME are uppercase, so this is not a WikiName
fooWikiName  - This begins with "foo", which is in all lowercase, so this is not a WikiName</pre>
<ul>
<li>Example output</li>
</ul>
<ul>
<li><ul>
<li>WikiName     - WikiName</li>
<li>HogeRule1    - WikiName</li>
<li>NOTWIKINAME  - All of the letters are uppercase, so this is not a WikiName</li>
<li>WikiNAME     - All of the letters in NAME are uppercase, so this is not a WikiName</li>
<li>fooWikiName  - This begins with "foo", which is in all lowercase, so this is not a WikiName</li>
</ul></li>
</ul>
<h2>Linking to other Wiki pages</h2>
<p>If a page name is surrounded with two pairs of brackets, it becomes a link to that page.</p>
<ul>
<li>Example statement</li>
</ul>
<pre>For example, if you write [[TextFormattingRules]], it becomes a link to that page.</pre>
<ul>
<li>Example output</li>
</ul>
<p>For example, if you write <a href="TextFormattingRules">TextFormattingRules</a>, it becomes a link to that page.</p>
<h2>Linking to an arbitrary URL</h2>
<p>If a phrase and URL, separated by a vertical line, are surrounded with two pairs of brackets, it becomes a link to an arbitrary URL.</p>
<ul>
<li>Example statement</li>
</ul>
<pre>Links like [[Yahoo!|http://www.yahoo.com/]] are also possible.</pre>
<ul>
<li>Example output</li>
</ul>
<p>Links like <a href="http://www.yahoo.com/">Yahoo!</a> are also possible.</p>
<p>Text in a paragraph that looks like a URL will automatically become a link.</p>
<ul>
<li>Example statement</li>
</ul>
<pre>Hiki's home page is http://hikiwiki.org/en/ (English).</pre>
<ul>
<li>Example output</li>
</ul>
<p>Hiki's home page is <a href="http://hikiwiki.org/en/">http://hikiwiki.org/en/</a> (English).</p>
<p>In this case, if the URL ends with jpg., .jpeg, .png, or .gif, the image is displayed on the page.</p>
<ul>
<li>Example statement</li>
</ul>
<pre>http://jp.rubyist.net/theme/clover/clover_h1.png</pre>
<ul>
<li>Example output</li>
</ul>
<p><img src="http://jp.rubyist.net/theme/clover/clover_h1.png" alt="clover_h1.png"></p>
<h1>Preformatted text</h1>
<p>Lines beginning with spaces or tabs will be treated as preformatted text.</p>
<ul>
<li>Example output</li>
</ul>
<pre>require 'cgi'

cgi = CGI::new
cgi.header

puts &lt;&lt;EOS
&lt;html&gt;
  &lt;head&gt;
    &lt;title&gt;Hello!&lt;/title&gt;
  &lt;/head&gt;
  &lt;body&gt;
  &lt;p&gt;Hello!&lt;/p&gt;
  &lt;/body&gt;
&lt;/html&gt;
EOS</pre>
<h1>Text decoration</h1>
<p>Text surrounded by sets of two single quotes ('') is emphasized.</p>
<p>Text surrounded by sets of three single quotes (''') is strongly emphasized.</p>
<p>Text surrounded by sets of double equal signs (===) is struck out.</p>
<ul>
<li>Example statement</li>
</ul>
<pre>If you write like this, it becomes ''emphasized''.
And if you write like this, it becomes '''strongly emphasized'''.
==This is dull, but== And struck-out text is supported, too!</pre>
<ul>
<li>Example output</li>
</ul>
<p>If you write like this, it becomes <em>emphasized</em>.
And if you write like this, it becomes <strong>strongly emphasized</strong>.
<del>This is dull, but</del> And struck-out text is supported, too!</p>
<h1>Headings</h1>
<p>Lines with exclamation marks at the beginning become headings.</p>
<p>One can use up to six exclamation marks; they will be converted to &lt;h1&gt; to &lt;h6&gt; tags.</p>
<ul>
<li>Example statement</li>
</ul>
<pre>!Heading1
!!Heading2
!!!Heading3
!!!!Heading4
!!!!!Heading5</pre>
<ul>
<li>Example output</li>
</ul>
<h1>Heading1</h1>
<h2>Heading2</h2>
<h3>Heading3</h3>
<h4>Heading4</h4>
<h5>Heading5</h5>
<h1>Horizontal lines</h1>
<p>Four hyphens at the beginning of the line (----) become a horizontal rule.</p>
<ul>
<li>Example statement</li>
</ul>
<pre>A B C D E
----
F G H I J</pre>
<ul>
<li>Example output</li>
</ul>
<p>A B C D E</p>
<hr>
<p>F G H I J</p>
<h1>Lists</h1>
<p>Lines beginning with asterisks become list items.</p>
<p>It is possible to use up to three asterisks; it is also possible to create nested lists.</p>
<p>Lines beginning with a # become numbered lists.</p>
<ul>
<li>Example statement</li>
</ul>
<pre>*Item 1
**Item 1.1
**Item 1.2
***Item 1.2.1
***Item 1.2.2
***Item 1.2.3
**Item 1.3
**Item 1.4
*Item 2</pre>
<pre>#Item 1
#Item 2
##Item 2.1
##Item 2.2
##Item 2.3
#Item 3
##Item 3.1
###Item 3.1.1
###Item 3.1.2</pre>
<ul>
<li>Example output</li>
</ul>
<ul>
<li>Item 1<ul>
<li>Item 1.1</li>
<li>Item 1.2<ul>
<li>Item 1.2.1</li>
<li>Item 1.2.2</li>
<li>Item 1.2.3</li>
</ul></li>
<li>Item 1.3</li>
<li>Item 1.4</li>
</ul></li>
<li>Item 2</li>
</ul>
<ol>
<li>Item 1</li>
<li>Item 2<ol>
<li>Item 2.1</li>
<li>Item 2.2</li>
<li>Item 2.3</li>
</ol></li>
<li>Item 3<ol>
<li>Item 3.1<ol>
<li>Item 3.1.1</li>
<li>Item 3.1.2</li>
</ol></li>
</ol></li>
</ol>
<h1>Quotations</h1>
<p>Lines beginning with two double quotes become quotations.</p>
<ul>
<li>Example statement</li>
</ul>
<pre>""This is a quotation.
""This is another quote.
""This is a continued quote.  When there are consecutive quotations,
""they are displayed as one quote,
""like this.</pre>
<ul>
<li>Example output</li>
</ul>
<blockquote><p>This is a quotation.
This is another quote.
This is a continued quote.  When there are consecutive quotations,
they are displayed as one quote,
like this.</p>
</blockquote>
<h1>Definitions</h1>
<p>Lines beginning with a colon and have a phrase and explanation separated by another colon will become a definition.</p>
<ul>
<li>Example statement</li>
</ul>
<pre>:ringo:apple
:gorira:gorilla
:rakuda:camel</pre>
<ul>
<li>Example output</li>
</ul>
<dl>
<dt>ringo</dt>
<dd>apple
</dd>
<dt>gorira</dt>
<dd>gorilla
</dd>
<dt>rakuda</dt>
<dd>camel
</dd>
</dl>
<h1>Tables</h1>
<p>Tables begin with two vertical bars.</p>
<p>Leading `!' in a cell means that it is a heading cell.</p>
<p>To concatenate columns or rows, put `&gt;'(columns) or `^'(rows) at head of
the cell.</p>
<ul>
<li>Example statement</li>
</ul>
<pre>||!row heading \ column heading||!column A||!column B||!column C||!&gt;column D-E (horizontal concatenation)
||!row 1||A1||B1||^C1-C2 (vertical concatenation)||D1||E1
||!row 2||A2||B2||^&gt;D2-E2-D3-E3 (vertical and horizontal concatenation)
||!row 3||&gt;&gt;A3-C3 (horizontal concatenation)</pre>
<ul>
<li>Example output</li>
</ul>
<table border="1">
<tr><th>row heading \ column heading</th><th>column A</th><th>column B</th><th>column C</th><th colspan="2">column D-E (horizontal concatenation)
</th></tr>
<tr><th>row 1</th><td>A1</td><td>B1</td><td rowspan="2">C1-C2 (vertical concatenation)</td><td>D1</td><td>E1
</td></tr>
<tr><th>row 2</th><td>A2</td><td>B2</td><td rowspan="2" colspan="2">D2-E2-D3-E3 (vertical and horizontal concatenation)
</td></tr>
<tr><th>row 3</th><td colspan="3">A3-C3 (horizontal concatenation)
</td></tr>
</table>
<h1>Comments</h1>
<p>Lines starting with `//' becomes a comment line.
Comment lines is not outputted.</p>
<ul>
<li>Example statement</li>
</ul>
<pre> // This is a comment line.</pre>
<ul>
<li>Example output (not displayed)</li>
</ul>
<h1>Plugins</h1>
<p>One can use a plugin by surrounding text with two pairs of brackets.
Multiple lines parameter is supported.
When a line contains plugin only, it is becomes a block plugin,
which is not surrounded by &lt;p&gt; ... &lt;/p&gt;.</p>
<ul>
<li>Example statement</li>
</ul>
<pre>{{recent(3)}}</pre>
<ul>
<li>Example statement of multiple lines</li>
</ul>
<pre>{{pre('
 ...
 ')}}</pre>

</body>
</html>
